<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: ecdev.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ecdev_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">ecdev.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="ecdev_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  $Id: ecdev.h,v 11c0b2caa253 2009/02/24 12:51:39 fp $</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *  This file is part of the IgH EtherCAT Master.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *  modify it under the terms of the GNU General Public License version 2, as</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *  published by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *  Public License for more details.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *  You should have received a copy of the GNU General Public License along</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *  with the IgH EtherCAT Master; if not, write to the Free Software</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *  ---</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *  The license mentioned above concerns the source code only. Using the</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> *  EtherCAT technology and brand is only permitted in compliance with the</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> *  industrial property and similar rights of Beckhoff Automation GmbH.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">#ifndef __ECDEV_H__</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#define __ECDEV_H__</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor">#include &lt;linux/netdevice.h&gt;</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">struct </span><a class="code" href="structec__device.html">ec_device</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="ecdev_8h.html#ac0895793ea540357d225d4b8be71f2e4">   53</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structec__device.html">ec_device</a> <a class="code" href="structec__device.html">ec_device_t</a>; </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="ecdev_8h.html#a789bcd88d869f88c58bd13b451b3fd52">   57</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="ecdev_8h.html#a789bcd88d869f88c58bd13b451b3fd52">ec_pollfunc_t</a>)(<span class="keyword">struct </span>net_device *);</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> * Offering/withdrawal functions</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<a class="code" href="structec__device.html">ec_device_t</a> *<a class="code" href="group__DeviceInterface.html#ga522b0264934a68d51cc5b67f2c76ef30">ecdev_offer</a>(<span class="keyword">struct</span> net_device *net_dev, <a class="code" href="ecdev_8h.html#a789bcd88d869f88c58bd13b451b3fd52">ec_pollfunc_t</a> poll,</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <span class="keyword">struct</span> module *module);</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__DeviceInterface.html#ga3934f8a07aa394d558147d790fc60a8b">ecdev_withdraw</a>(<a class="code" href="structec__device.html">ec_device_t</a> *device);</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> * Device methods</span></div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__DeviceInterface.html#ga34eceaecfe6ab4fe8f0ecde1a3b311c4">ecdev_open</a>(<a class="code" href="structec__device.html">ec_device_t</a> *device);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__DeviceInterface.html#ga0a6b26b2397aa49cc82915a12b8cc854">ecdev_close</a>(<a class="code" href="structec__device.html">ec_device_t</a> *device);</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__DeviceInterface.html#gaf02497a3d6bb0e43dcefc1802f8666a5">ecdev_receive</a>(<a class="code" href="structec__device.html">ec_device_t</a> *device, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__DeviceInterface.html#gac1d0e31b8b60ad4e94c03148aac88499">ecdev_set_link</a>(<a class="code" href="structec__device.html">ec_device_t</a> *device, uint8_t state);</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;uint8_t <a class="code" href="group__DeviceInterface.html#gaa31bc8d955fea01e8430105c61064589">ecdev_get_link</a>(<span class="keyword">const</span> <a class="code" href="structec__device.html">ec_device_t</a> *device);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="group__DeviceInterface_html_ga0a6b26b2397aa49cc82915a12b8cc854"><div class="ttname"><a href="group__DeviceInterface.html#ga0a6b26b2397aa49cc82915a12b8cc854">ecdev_close</a></div><div class="ttdeci">void ecdev_close(ec_device_t *device)</div><div class="ttdoc">Makes the master leave IDLE phase and closes the network device. </div><div class="ttdef"><b>Definition:</b> <a href="device_8c_source.html#l00612">device.c:612</a></div></div>
<div class="ttc" id="group__DeviceInterface_html_ga34eceaecfe6ab4fe8f0ecde1a3b311c4"><div class="ttname"><a href="group__DeviceInterface.html#ga34eceaecfe6ab4fe8f0ecde1a3b311c4">ecdev_open</a></div><div class="ttdeci">int ecdev_open(ec_device_t *device)</div><div class="ttdoc">Opens the network device and makes the master enter IDLE phase. </div><div class="ttdef"><b>Definition:</b> <a href="device_8c_source.html#l00574">device.c:574</a></div></div>
<div class="ttc" id="ecdev_8h_html_a789bcd88d869f88c58bd13b451b3fd52"><div class="ttname"><a href="ecdev_8h.html#a789bcd88d869f88c58bd13b451b3fd52">ec_pollfunc_t</a></div><div class="ttdeci">void(* ec_pollfunc_t)(struct net_device *)</div><div class="ttdoc">Device poll function type. </div><div class="ttdef"><b>Definition:</b> <a href="ecdev_8h_source.html#l00057">ecdev.h:57</a></div></div>
<div class="ttc" id="structec__device_html"><div class="ttname"><a href="structec__device.html">ec_device</a></div><div class="ttdoc">EtherCAT device. </div><div class="ttdef"><b>Definition:</b> <a href="device_8h_source.html#l00081">device.h:81</a></div></div>
<div class="ttc" id="group__DeviceInterface_html_gaa31bc8d955fea01e8430105c61064589"><div class="ttname"><a href="group__DeviceInterface.html#gaa31bc8d955fea01e8430105c61064589">ecdev_get_link</a></div><div class="ttdeci">uint8_t ecdev_get_link(const ec_device_t *device)</div><div class="ttdoc">Reads the link state. </div><div class="ttdef"><b>Definition:</b> <a href="device_8c_source.html#l00704">device.c:704</a></div></div>
<div class="ttc" id="group__DeviceInterface_html_gaf02497a3d6bb0e43dcefc1802f8666a5"><div class="ttname"><a href="group__DeviceInterface.html#gaf02497a3d6bb0e43dcefc1802f8666a5">ecdev_receive</a></div><div class="ttdeci">void ecdev_receive(ec_device_t *device, const void *data, size_t size)</div><div class="ttdoc">Accepts a received frame. </div><div class="ttdef"><b>Definition:</b> <a href="device_8c_source.html#l00634">device.c:634</a></div></div>
<div class="ttc" id="group__DeviceInterface_html_ga522b0264934a68d51cc5b67f2c76ef30"><div class="ttname"><a href="group__DeviceInterface.html#ga522b0264934a68d51cc5b67f2c76ef30">ecdev_offer</a></div><div class="ttdeci">ec_device_t * ecdev_offer(struct net_device *net_dev, ec_pollfunc_t poll, struct module *module)</div><div class="ttdoc">Offers an EtherCAT device to a certain master. </div><div class="ttdef"><b>Definition:</b> <a href="module_8c_source.html#l00473">module.c:473</a></div></div>
<div class="ttc" id="group__DeviceInterface_html_gac1d0e31b8b60ad4e94c03148aac88499"><div class="ttname"><a href="group__DeviceInterface.html#gac1d0e31b8b60ad4e94c03148aac88499">ecdev_set_link</a></div><div class="ttdeci">void ecdev_set_link(ec_device_t *device, uint8_t state)</div><div class="ttdoc">Sets a new link state. </div><div class="ttdef"><b>Definition:</b> <a href="device_8c_source.html#l00678">device.c:678</a></div></div>
<div class="ttc" id="group__DeviceInterface_html_ga3934f8a07aa394d558147d790fc60a8b"><div class="ttname"><a href="group__DeviceInterface.html#ga3934f8a07aa394d558147d790fc60a8b">ecdev_withdraw</a></div><div class="ttdeci">void ecdev_withdraw(ec_device_t *device)</div><div class="ttdoc">Withdraws an EtherCAT device from the master. </div><div class="ttdef"><b>Definition:</b> <a href="device_8c_source.html#l00543">device.c:543</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_07b86ffc266b39efa5bbdc0e9fdb330a.html">devices</a></li><li class="navelem"><a class="el" href="ecdev_8h.html">ecdev.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
